<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta content="en" name="language">
	<title>list</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
	<link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">

</head>

<body>

<div class="banner">
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
<span class="title">GraphicsMagick</span>
<form action="http://www.google.com/search">
  <input type="hidden" name="domains" value="www.graphicsmagick.org" />
  <input type="hidden" name="sitesearch" value="www.graphicsmagick.org" />
<span class="nowrap"><input type="text" name="q" size="25" maxlength="255" />&nbsp;<input type="submit" name="sa" value="Search" /></span>
</form>
</div>


<div class="navmenu">
<ul>
  <li><a href="../index.html">Home</a></li>
  <li><a href="../project.html">Project</a></li>
  <li><a href="../download.html">Download</a></li>
  <li><a href="../README.html">Install</a></li>
  <li><a href="../Hg.html">Source</a></li>
  <li><a href="../NEWS.html">News</a> </li>
  <li><a href="../utilities.html">Utilities</a></li>
  <li><a href="../programming.html">Programming</a></li>
  <li><a href="../reference.html">Reference</a></li>
</ul>
</div>

<main id="list">
<h1 class="title">list</h1>
<p class="subtitle" id="image-list-support">Image list support</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#appendimagetolist" id="id41">AppendImageToList</a></p></li>
<li><p><a class="reference internal" href="#cloneimagelist" id="id42">CloneImageList</a></p></li>
<li><p><a class="reference internal" href="#deleteimagefromlist" id="id43">DeleteImageFromList</a></p></li>
<li><p><a class="reference internal" href="#destroyimagelist" id="id44">DestroyImageList</a></p></li>
<li><p><a class="reference internal" href="#getfirstimageinlist" id="id45">GetFirstImageInList</a></p></li>
<li><p><a class="reference internal" href="#getimagefromlist" id="id46">GetImageFromList</a></p></li>
<li><p><a class="reference internal" href="#getimageindexinlist" id="id47">GetImageIndexInList</a></p></li>
<li><p><a class="reference internal" href="#getimagelistlength" id="id48">GetImageListLength</a></p></li>
<li><p><a class="reference internal" href="#getlastimageinlist" id="id49">GetLastImageInList</a></p></li>
<li><p><a class="reference internal" href="#getnextimageinlist" id="id50">GetNextImageInList</a></p></li>
<li><p><a class="reference internal" href="#getpreviousimageinlist" id="id51">GetPreviousImageInList</a></p></li>
<li><p><a class="reference internal" href="#imagelisttoarray" id="id52">ImageListToArray</a></p></li>
<li><p><a class="reference internal" href="#insertimageinlist" id="id53">InsertImageInList</a></p></li>
<li><p><a class="reference internal" href="#newimagelist" id="id54">NewImageList</a></p></li>
<li><p><a class="reference internal" href="#prependimagetolist" id="id55">PrependImageToList</a></p></li>
<li><p><a class="reference internal" href="#removefirstimagefromlist" id="id56">RemoveFirstImageFromList</a></p></li>
<li><p><a class="reference internal" href="#removelastimagefromlist" id="id57">RemoveLastImageFromList</a></p></li>
<li><p><a class="reference internal" href="#replaceimageinlist" id="id58">ReplaceImageInList</a></p></li>
<li><p><a class="reference internal" href="#reverseimagelist" id="id59">ReverseImageList</a></p></li>
<li><p><a class="reference internal" href="#spliceimageintolist" id="id60">SpliceImageIntoList</a></p></li>
<li><p><a class="reference internal" href="#splitimagelist" id="id61">SplitImageList</a></p></li>
</ul>
</div>
<section id="appendimagetolist">
<h1><a class="toc-backref" href="#id41">AppendImageToList</a></h1>
<section id="synopsis">
<h2>Synopsis</h2>
<pre class="literal-block">AppendImageToList( <a class="reference external" href="../api/types.html#image">Image</a> ** images, <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
</section>
<section id="description">
<h2>Description</h2>
<p>AppendImageToList() appends an image to the end of the list.  Please
note that this API allows the list pointer to be updated and in fact
it now updates the list pointer to be the image (or the end of the
image list) which was just added.</p>
<p>The format of the AppendImageToList method is:</p>
<pre class="literal-block">AppendImageToList( <a class="reference external" href="../api/types.html#image">Image</a> ** images, <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
</dl>
</section>
</section>
<section id="cloneimagelist">
<h1><a class="toc-backref" href="#id42">CloneImageList</a></h1>
<section id="id1">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *CloneImageList( const <a class="reference external" href="../api/types.html#image">Image</a> *images, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</section>
<section id="id2">
<h2>Description</h2>
<p>CloneImageList() returns a duplicate of the image list.</p>
<p>The format of the CloneImageList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *CloneImageList( const <a class="reference external" href="../api/types.html#image">Image</a> *images, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</section>
</section>
<section id="deleteimagefromlist">
<h1><a class="toc-backref" href="#id43">DeleteImageFromList</a></h1>
<section id="id3">
<h2>Synopsis</h2>
<pre class="literal-block">DeleteImageFromList( <a class="reference external" href="../api/types.html#image">Image</a> ** images );</pre>
</section>
<section id="id4">
<h2>Description</h2>
<p>DeleteImageFromList() deletes an image from the list.</p>
<p>The format of the DeleteImageFromList method is:</p>
<pre class="literal-block">DeleteImageFromList( <a class="reference external" href="../api/types.html#image">Image</a> ** images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="destroyimagelist">
<h1><a class="toc-backref" href="#id44">DestroyImageList</a></h1>
<section id="id5">
<h2>Synopsis</h2>
<pre class="literal-block">void DestroyImageList( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
</section>
<section id="id6">
<h2>Description</h2>
<p>DestroyImageList() destroys an image list.  There is no effect if the
image pointer is null.</p>
<p>The format of the DestroyImageList method is:</p>
<pre class="literal-block">void DestroyImageList( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>image:</dt>
<dd><p>The image sequence.</p>
</dd>
</dl>
</section>
</section>
<section id="getfirstimageinlist">
<h1><a class="toc-backref" href="#id45">GetFirstImageInList</a></h1>
<section id="id7">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetFirstImageInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
</section>
<section id="id8">
<h2>Description</h2>
<p>GetFirstImageInList() returns a pointer to the first image in the list</p>
<p>The format of the GetFirstImageInList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetFirstImageInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="getimagefromlist">
<h1><a class="toc-backref" href="#id46">GetImageFromList</a></h1>
<section id="id9">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetImageFromList( const <a class="reference external" href="../api/types.html#image">Image</a> *images, const long offset );</pre>
</section>
<section id="id10">
<h2>Description</h2>
<p>GetImageFromList() returns an image at the specified offset from the list.</p>
<p>The format of the GetImageFromList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetImageFromList( const <a class="reference external" href="../api/types.html#image">Image</a> *images, const long offset );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
<dt>offset:</dt>
<dd><p>The position within the list.</p>
</dd>
</dl>
</section>
</section>
<section id="getimageindexinlist">
<h1><a class="toc-backref" href="#id47">GetImageIndexInList</a></h1>
<section id="id11">
<h2>Synopsis</h2>
<pre class="literal-block">long GetImageIndexInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
</section>
<section id="id12">
<h2>Description</h2>
<p>GetImageIndexInList() returns the offset in the list of the specified image.</p>
<p>The format of the GetImageIndexInList method is:</p>
<pre class="literal-block">long GetImageIndexInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="getimagelistlength">
<h1><a class="toc-backref" href="#id48">GetImageListLength</a></h1>
<section id="id13">
<h2>Synopsis</h2>
<pre class="literal-block">unsigned long GetImageListLength( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
</section>
<section id="id14">
<h2>Description</h2>
<p>GetImageListLength() returns the length of the list (the number of images in
the list).</p>
<p>The format of the GetImageListLength method is:</p>
<pre class="literal-block">unsigned long GetImageListLength( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="getlastimageinlist">
<h1><a class="toc-backref" href="#id49">GetLastImageInList</a></h1>
<section id="id15">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetLastImageInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
</section>
<section id="id16">
<h2>Description</h2>
<p>GetLastImageInList() returns a pointer to the last image in the list</p>
<p>The format of the GetLastImageInList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetLastImageInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="getnextimageinlist">
<h1><a class="toc-backref" href="#id50">GetNextImageInList</a></h1>
<section id="id17">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetNextImageInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
</section>
<section id="id18">
<h2>Description</h2>
<p>GetNextImageInList() returns the next image in the list.</p>
<p>The format of the GetNextImageInList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetNextImageInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="getpreviousimageinlist">
<h1><a class="toc-backref" href="#id51">GetPreviousImageInList</a></h1>
<section id="id19">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetPreviousImageInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
</section>
<section id="id20">
<h2>Description</h2>
<p>GetPreviousImageInList() returns the previous image in the list.</p>
<p>The format of the GetPreviousImageInList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetPreviousImageInList( const <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="imagelisttoarray">
<h1><a class="toc-backref" href="#id52">ImageListToArray</a></h1>
<section id="id21">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> ** ImageListToArray( const <a class="reference external" href="../api/types.html#image">Image</a> *images, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</section>
<section id="id22">
<h2>Description</h2>
<p>ImageListToArray() is a convenience method that converts an image list to
a sequential array.  For example,</p>
<p>group = ImageListToArray(images, exception);
for (i = 0; i &lt; n; i++)
puts(group[i]-&gt;filename);</p>
<p>The format of the ImageListToArray method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> ** ImageListToArray( const <a class="reference external" href="../api/types.html#image">Image</a> *images, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>image:</dt>
<dd><p>The image list.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</section>
</section>
<section id="insertimageinlist">
<h1><a class="toc-backref" href="#id53">InsertImageInList</a></h1>
<section id="id23">
<h2>Synopsis</h2>
<pre class="literal-block">InsertImageInList( <a class="reference external" href="../api/types.html#image">Image</a> ** images, <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
</section>
<section id="id24">
<h2>Description</h2>
<p>InsertImageInList() inserts an image in the list.</p>
<p>The format of the InsertImageInList method is:</p>
<pre class="literal-block">InsertImageInList( <a class="reference external" href="../api/types.html#image">Image</a> ** images, <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
</dl>
</section>
</section>
<section id="newimagelist">
<h1><a class="toc-backref" href="#id54">NewImageList</a></h1>
<section id="id25">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *NewImageList( void );</pre>
</section>
<section id="id26">
<h2>Description</h2>
<p>NewImageList() creates an empty image list.</p>
<p>The format of the NewImageList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *NewImageList( void );</pre>
</section>
</section>
<section id="prependimagetolist">
<h1><a class="toc-backref" href="#id55">PrependImageToList</a></h1>
<section id="id27">
<h2>Synopsis</h2>
<pre class="literal-block">PrependImageToList( <a class="reference external" href="../api/types.html#image">Image</a> *images, <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
</section>
<section id="id28">
<h2>Description</h2>
<p>PrependImageToList() prepends the image to the beginning of the list.</p>
<p>The format of the PrependImageToList method is:</p>
<pre class="literal-block">PrependImageToList( <a class="reference external" href="../api/types.html#image">Image</a> *images, <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
</dl>
</section>
</section>
<section id="removefirstimagefromlist">
<h1><a class="toc-backref" href="#id56">RemoveFirstImageFromList</a></h1>
<section id="id29">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *RemoveFirstImageFromList( <a class="reference external" href="../api/types.html#image">Image</a> ** images );</pre>
</section>
<section id="id30">
<h2>Description</h2>
<p>RemoveFirstImageFromList() removes an image from the beginning of the list.</p>
<p>The format of the RemoveFirstImageFromList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *RemoveFirstImageFromList( <a class="reference external" href="../api/types.html#image">Image</a> ** images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="removelastimagefromlist">
<h1><a class="toc-backref" href="#id57">RemoveLastImageFromList</a></h1>
<section id="id31">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *RemoveLastImageFromList( <a class="reference external" href="../api/types.html#image">Image</a> ** images );</pre>
</section>
<section id="id32">
<h2>Description</h2>
<p>RemoveLastImageFromList() removes the last image from the list.</p>
<p>The format of the RemoveLastImageFromList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *RemoveLastImageFromList( <a class="reference external" href="../api/types.html#image">Image</a> ** images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="replaceimageinlist">
<h1><a class="toc-backref" href="#id58">ReplaceImageInList</a></h1>
<section id="id33">
<h2>Synopsis</h2>
<pre class="literal-block">ReplaceImageInList( <a class="reference external" href="../api/types.html#image">Image</a> ** images, <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
</section>
<section id="id34">
<h2>Description</h2>
<p>ReplaceImageInList() replaces an image in the list.</p>
<p>The format of the ReplaceImageInList method is:</p>
<pre class="literal-block">ReplaceImageInList( <a class="reference external" href="../api/types.html#image">Image</a> ** images, <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
</dl>
</section>
</section>
<section id="reverseimagelist">
<h1><a class="toc-backref" href="#id59">ReverseImageList</a></h1>
<section id="id35">
<h2>Synopsis</h2>
<pre class="literal-block">ReverseImageList( const <a class="reference external" href="../api/types.html#image">Image</a> ** images );</pre>
</section>
<section id="id36">
<h2>Description</h2>
<p>ReverseImageList() reverses the image list.</p>
<p>The format of the ReverseImageList method is:</p>
<pre class="literal-block">ReverseImageList( const <a class="reference external" href="../api/types.html#image">Image</a> ** images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
<section id="spliceimageintolist">
<h1><a class="toc-backref" href="#id60">SpliceImageIntoList</a></h1>
<section id="id37">
<h2>Synopsis</h2>
<pre class="literal-block">SpliceImageIntoList( <a class="reference external" href="../api/types.html#image">Image</a> ** images, const unsigned long length, <a class="reference external" href="../api/types.html#image">Image</a> *splice );</pre>
</section>
<section id="id38">
<h2>Description</h2>
<p>SpliceImageIntoList() removes 'length' images from the list and replaces
them with the specified splice.</p>
<p>The format of the SpliceImageIntoList method is:</p>
<pre class="literal-block">SpliceImageIntoList( <a class="reference external" href="../api/types.html#image">Image</a> ** images, const unsigned long length, <a class="reference external" href="../api/types.html#image">Image</a> *splice );</pre>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
<dt>length:</dt>
<dd><p>The length of the image list to remove.</p>
</dd>
<dt>splice:</dt>
<dd><p>Replace the removed image list with this list.</p>
</dd>
</dl>
</section>
</section>
<section id="splitimagelist">
<h1><a class="toc-backref" href="#id61">SplitImageList</a></h1>
<section id="id39">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SplitImageList( <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
</section>
<section id="id40">
<h2>Description</h2>
<p>SplitImageList() splits an image into two lists.</p>
<p>The format of the SplitImageList method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SplitImageList( <a class="reference external" href="../api/types.html#image">Image</a> *images );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>images:</dt>
<dd><p>The image list.</p>
</dd>
</dl>
</section>
</section>
</main>


<hr class="docutils">
<div class="document">
    <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002-2025<!--SPONSOR_LOGO--></p>
</div>

</main>
</body>
</html>
